/*
   Copyright (C) 2004 Chris Emerson
   (based on push button by Carlos Ghirardelli)

This file is part of the libgpsim_modules library of gpsim

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, see 
<http://www.gnu.org/licenses/lgpl-2.1.html>.
*/



#ifndef __ENC_H__
#define __ENC_H__

/* IN_MODULE should be defined for modules */
#define IN_MODULE

#include <gpsim/stimuli.h>
#include <gpsim/ioports.h>
#include <gpsim/symbol.h>
#include <gpsim/trace.h>
#include <gpsim/modules.h>

#include <gtk/gtk.h>

class MomentaryEncoder : public Module, private TriggerObject
{
    void create_widget(MomentaryEncoder *enc);
public:

    IOPIN *a_pin;
    IOPIN *b_pin;
    IOPIN *but_pin;

    MomentaryEncoder(const char *);
    ~MomentaryEncoder(void);


    void test(void);
    void update(void);

    /* Send clockwise pulses */
    void send_cw(void);
    /* Send anticlockwise pulses */
    void send_ccw(void);
    /* Send button pulse */
    void send_but(void);

    // Inheritances from the Package class
    virtual void create_iopin_map(void);

    // Inheritance from Module class
    const virtual char *type(void) { return ("encoder"); };
    static Module *construct(const char *new_name);

private:
    enum rotate_state {
	rot_detent,
	rot_moving_cw,
	rot_moving_ccw,
	rot_button_press
    };
    rotate_state rs;
    void toggle_a();
    void toggle_b();
    void toggle_but();
    void schedule_tick();
    void schedule_tick(int cycles);
    void callback();
};

#endif //  __ENC_H__
